/*
							Copyright (C) 2010  Alourien Team
									
						This file is part of the Alourien Engine.

    The Alourien Engine is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    The Alourien Engine is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with the Alourien Engine.  If not, see <http://www.gnu.org/licenses/>.
	
 *File Name:Vector3D.h
 *Programmer Name:Jose Castellano
 *Date of Last Update: 10/27/2010
 *
 *Purpose:This Program is to create a three dimensional 
 * Vector to be used in later programs
 *
 *Basic Info:It includes the vector set function 
 *which allows to set all three values at once.
 *
 *UPDATES:
 *1)Created the Program and documentation.
 *  Date:9/30/2010 Updater: Jose Castellano
 *
 *2)Fixed the documentation to the standard that
 *  we decided to use.
 *  Date:10/1/2010 Updater: Jose Castellano
 *
 *3) Added the actual code to our Engine namespace
 *   Date" 10/06/2010 Updater: Manuel Cuellar
 *
 *4) Added VectorMath as a friend class
 *   Date: 10/27/2010 Updater: Manuel Cuellar
 *
 */

#ifndef _VECTOR3D_H
#define _VECTOR3D_H 1

namespace Alourien
{
	class Vector3D
	{
		//Allow VectorMath access to our private variables
		friend class VectorMath;
	private:
		//Object coordinates
		float x; // This is the X value of the Vector
		float y; // This is the Y value of the Vector
		float z; // This is the Z value of the Vector

	public:
		Vector3D(void);
		~Vector3D(void);

		//Mutators and Accessors
		float getX(){return this->x;}
		void setX(float value) {this->x = value;}
		float getY(){return this->y;}
		void setY(float value) {this->y = value;}
		float getZ(){return this->z;}
		void setZ(float value) {this->z = value;}        

		//This function is to get the values and set them into the vector
		//It allows for a faster initialization, rather than setting in the main
		//using three lines of code.
		void VectorSet(float xValue, float yValue, float zValue);
		
		//Overload of the + operator but for 3 Dimensional Vectors
		//Returns a 3 dimensional vector
		Vector3D operator+(const Vector3D& vector2) const;

		//Overload of the * operator but for 3 Dimensional Vectors
		//Returns a 3 dimensional vector
		Vector3D operator*(const Vector3D& vector2) const;

	};
};

#endif 